/*
    YmsgIRC - Program enabling YMSG chat clients to use IRC
    Copyright (C) 2011 Crash Daemonicus ( crashenator -at- gmail.com )

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file   channel.h
 * @author crashenator (crashenator -at- gmail.com)
 * @brief  A channel/chatroom implementation.
 * @details ...
 */

#pragma once
#include "common.h"
#include <list>

/** @brief A channel/chatroom class. 
	@details ...
*/
class Channel
{
    private:

    public:
        string  name;///< explicit name of the chatroom or channel.
        string  topic;///< topic or description text for the chatroom.
		list<string> users;///< list of usernames occupying the chatroom.

		/** @brief resets all information about the channel
			@details also sets Channel::name to "#", Channel::topic to "IRC Channel"; which is arbitrary (must be changed regardless with any default)
		*/
        void reset();

		/// @brief constructor. calls reset()
		/// @see reset()
        Channel();
        ~Channel();
};

